tests: Improve e2e test setup error reporting #1943
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aThorp96
force-pushed
the
improve-e2e-test-setup-env-validation
branch
from
b41ff42 to
d41fede
Compare
|
/retest go-testing |
chmouel
reviewed
Feb 20, 2025
| "os" | ||
| ) | ||
|
|
||
| func RequireEnvs(keys ...string) error { |
There was a problem hiding this comment.
Suggested change
| func RequireEnvs(keys ...string) error { | |
| // RequireEnvs checks if all required environment variables are set. | |
| // It takes a variadic list of environment variable keys and returns an error | |
| // if any of the required variables are not set. | |
| func RequireEnvs(keys ...string) error { |
| return nil | ||
| } | ||
|
|
||
| func GetRequiredEnv(key string) (string, error) { |
There was a problem hiding this comment.
Suggested change
| func GetRequiredEnv(key string) (string, error) { | |
| // GetRequiredEnv retrieves the value of a required environment variable. | |
| // If the environment variable is not set or is empty, it returns an error. | |
| func GetRequiredEnv(key string) (string, error) { |
chmouel
approved these changes
Feb 20, 2025
|
LGTM, not absolutely necessary just maybe add some documentation on function... |
aThorp96
force-pushed
the
improve-e2e-test-setup-env-validation
branch
from
d41fede to
e9f2bde
Compare
|
/lgtm |
![pipelines-as-code[bot]](https://avatars.githubusercontent.com/in/112592?s=60&v=4){kind=small}
There was a problem hiding this comment.
✅ Pull Request Approved
Approval Status:
- Required Approvals: 1
- Current Approvals: 2
👥 Approved By:
| Reviewer | Permission | Status |
|---|---|---|
| @chmouel | admin |
✅ |
| @vdemeester | admin |
✅ |
📝 Next Steps
- All required checks must pass
- Branch protection rules apply
- Get a maintainer to use the
/mergecommand to merge the PR
Thank you for your contributions! 🎉
|
/merge |
🔒 Insufficient Permissions
Please request assistance from a repository maintainer. |
- collect required environment variable checks into one place - report all missing required env-vars instead of just the first failure
aThorp96
force-pushed
the
improve-e2e-test-setup-env-validation
branch
from
e9f2bde to
d4c2938
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Submitter Checklist
📝 Ensure your commit message is clear and informative. Refer to the How to write a git commit message guide. Include the commit message in the PR body rather than linking to an external site (e.g., Jira ticket).
♽ Run make test lint before submitting a PR to avoid unnecessary CI processing. Consider installing pre-commit and running pre-commit install in the repository root for an efficient workflow.
✨ We use linters to maintain clean and consistent code. Run make lint before submitting a PR. Some linters offer a --fix mode, executable with make fix-linters (ensure markdownlint and golangci-lint are installed).
📖 Document any user-facing features or changes in behavior.
🧪 While 100% coverage isn't required, we encourage unit tests for code changes where possible.
🎁 If feasible, add an end-to-end test. See README for details.
🔎 Address any CI test flakiness before merging, or provide a valid reason to bypass it (e.g., token rate limitations).
If adding a provider feature, fill in the following details:
(update the documentation accordingly)